home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / bb645.arc / READ.ME < prev    next >
Text File  |  1987-02-28  |  9KB  |  242 lines
  1.                   ██████████
  2.                                 ██████████████
  3.                    ███ · ████ · ███
  4.                                 ██████████████
  5.                                 ██████  ██████
  6.                                  ████████████
  7.                                    ████████
  8.                                   ██││││││██
  9.                                    ████████
  10.                                ██▄          ▄██
  11.                                 ▀██▄      ▄██▀
  12.                                   ▀██▄  ▄██▀
  13.                                     ▀████▀
  14.                                     ▄████▄
  15.                                   ▄██▀  ▀██▄
  16.                                 ▄██▀      ▀██▄
  17.                                ██▀          ▀██
  18.  
  19.                                 ┌────────────┐
  20.                                 │ BLACKBEARD │
  21.                                 └────────────┘
  22.  
  23.                             User Supported Software
  24.  
  25.    Blackbeard is designed to be a programmer's editor.  It
  26. performs the editing tasks a programmer needs, in as fast and
  27. efficient manner as possible.  It works the way you expect it
  28. to.  The primary use for Blackbeard is for source code editing
  29. and it does all the things you would expect.  It also has some
  30. word processing features; these were used to create this read.me
  31. file.
  32.  
  33. DOCUMENTATION
  34.  
  35.    Blackbeard does not come with a voluminous manual.  The design
  36. team decided early on that a good editor should not need a large
  37. reference manual; most of the documentation is built in.  The
  38. file BB.DOC explans the more complex features of Blackbeard.
  39.  
  40.    The Blackbeard diskette should have the following files:
  41.  
  42.      File              Description
  43.      -------------------------------------------------------
  44.      bb.exe            This is the Blackbeard program.
  45.  
  46.      bbc.exe           Blackbeard key binding compiler.
  47.  
  48.      bbf.exe           Blackbeard text formatter. See BBF.DOC
  49.                instructions. Turns Blackbeard into a
  50.                full-featured word processor.
  51.  
  52.      bb.cfg            Blackbeard configuration file
  53.  
  54.      bb.key            Blackbeard key binding file compiled.
  55.                NOT PRESENT ON DISKETTE. You create
  56.                this file by selecting the Write
  57.                Bindings Option on the
  58.                Options/Settings menu.
  59.  
  60.      read.me           Blackbeard release notes
  61.  
  62.      bb.doc            Blackbeard manual
  63.  
  64.      bbf.doc           Blackbeard formatter manual.
  65.  
  66.      bbkeys.txt        Blackbeard key binding file ready for
  67.                compilation.
  68.  
  69.      m_bb.msc          Blackbeard Mouse systems button and
  70.                movement defintion file
  71.  
  72.      m_bb.com          Blackbeard Mouse systems compiled menu
  73.                file.
  74.  
  75.      form.txt          Blackbeard order form.
  76.  
  77.  
  78. RUNNING BLACKBEARD
  79.  
  80.    To run blackbeard simply type:
  81.  
  82.       BB
  83.  
  84.    at the DOS prompt.  Blackbeard will display the startup screen
  85. and ask you for a file to edit (use this one to get started).
  86. You can enter a file name or just press return for a menu of
  87. available files in your current directory.
  88.  
  89.    To install backbeard  memory resident use:
  90.  
  91.       BB =R
  92.  
  93.    Blackbeard will install and consume about 128k of memory. Use
  94. <ALT> = or <ALT> - to invoke the editor.
  95.  
  96.    You can give Blackbeard a filename upon startup:
  97.  
  98.       BB <filename>
  99.  
  100.    When Blackbeard starts up it looks for two files: the
  101. configuration file and the macro file.  Both the configuration
  102. file and the macro file are optional.
  103.  
  104. Configuration File
  105.  
  106.    Blackbeard keeps a configuration file that will allow you to
  107. customize the following areas:
  108.  
  109.       -  all items from the OPTIONS MENU
  110.       -  all items from the SETTINGS MENU
  111.       -  Window colors
  112.       -  WIndow sizes
  113.       -  the status line settings
  114.  
  115.    Blackbeard looks in the current subdirectory for a file named
  116. BB.CFG.  This file will be used to set the configuration
  117. setttings.  If there is not a file named BB.CFG in the current
  118. subdirectory, Blackbeard will look in the DOS environment for the
  119. symbol BBCFG, if it is found it will use the filename supplied
  120. with the symbol.  This will let you keep one configuration file
  121. and use Blackbeard from any disk or directory.
  122.  
  123.    To set BBCFG place this command or one similar in you
  124. autoexec.bat file
  125.  
  126.          SET BBCFG=C:\BB.CFG
  127.  
  128.    See the OPTIONS/SETTINGS menu for the read and save
  129. configuration commands.  These commands will request a filename
  130. and default to the current path and BB.CFG filename if none is
  131. given.
  132.  
  133. Macro file
  134.  
  135.    Blackbeard allows you to define and save keyboard macros.
  136. Blackbeard looks in the current subdirectory for a file named
  137. BB.MAC.  This file will be used to read in your macros.  If there
  138. is not a file named BB.MAC in the current subdirectory,
  139. Blackbeard will look in the DOS environment fo the symbol BBMAC,
  140. if it is found it will use the filename supplied with the symbol.
  141.  
  142.    To set BBMAC place this command or one similar in you
  143. autoexec.bat file
  144.  
  145.          SET BBMAC=C:\BB.MAC
  146.  
  147.    See the macros menu for the read and save macro commands.  To
  148. read in macro files with different filenames simply enter the
  149. desired file name to the read file prompt.  These commands will
  150. request a filename and default to the current path and BB.CFG
  151. filename if none is given.
  152.  
  153. MENUS
  154.  
  155.    To access the menus and learn the commands press the escape
  156. <Esc> key and the menu will pop-up.  You can execute a command or
  157. select any submenus by positioning the cursor on the item (using
  158. the keypad keys) and pressing the enter key (─┘).  To exit a
  159. menu without choosing an item press the escape key.  The menu
  160. action will be taken where the cursor was before you entered the
  161. menu.  WIth few exceptions the menu commands all have their
  162. direct keyboard counterparts which are described to the right of
  163. the English command description.  The direct commands use the
  164. keyboard letters and the shift () , Alt, and control (Ctrl)
  165. keys.  The following describes how they are shown on the menu:
  166.  
  167.          ^R - means Ctrl-R
  168.          R - means Shift-R
  169.          αR - means Alt-R
  170.  
  171.    The function keys are designated as F1 - F10.
  172.  
  173. OPTIONS MENU AND STATUS LINE MENU
  174.  
  175.    The options and status line menus toggles with ON shown as
  176. high intensity and OFF as normal intensity.  To toggle an item
  177. use the enter key.
  178.  
  179. THE MOUSE
  180.  
  181. Microsoft
  182.  
  183.    Blackbeard includes integral mouse support for the Microsoft
  184. mouse.  Mouse movements are tranlsated into cursor movements; the
  185. left button is translated to enter and used to select menu items;
  186. the right button is translated to escape and used to pop-up and
  187. exit menus.
  188.  
  189. Mouse Systems
  190.  
  191.    The Blackbeard distribution diskette includes a mouse menu
  192. driver for the Mouse Systems Mouse.  To use the mouse install the
  193. PC mouse menu driver by running MOUSESYS (this is described in
  194. your Mouse Systems Manual).  Run the Blackbeard menu program with
  195. the following command:
  196.  
  197.       M_BB
  198.  
  199.    This will install a mouse driver for Blackbeard.  Mouse
  200. movements are tranlsated into cursor movements; the left button
  201. is translated to enter and used to select menu items; the right
  202. button is translated to escape and used to pop-up and exit menus;
  203. the middle button and pressing the left and right buttons
  204. simultaneously (emulates αE) will repeat the last menu command.
  205.  
  206. LEARNING TO USE BLACKBEARD
  207.  
  208.    The best way to learn how to use Blackbeard (or any product)
  209. is to use it.
  210.  
  211. Distribution and Registration
  212.  
  213.    As you know software copyright violation is rampant.  This is
  214. why we have created Blackbeard.  Because Blackbeard is a superior
  215. text editor and available for free distribution, there will be no
  216. need to pirate copyright sfotware to obtain advanced text editing
  217. features.  Please feel free to give Blackbeard to you friends.
  218. We are counting on you as a participant in the largest
  219. distribution network in the nation (the owners and users of PCs)
  220. to make Blackbeard a popular product.  With strong user support,
  221. Blackbeard will be enhanced with new features and capabilities
  222. making it the programmer's editor of choice.
  223.  
  224.    For fifteen (15) dollars you can become a registered owner of
  225. Blackbeard.  For your $15.00 you will appease your conscience
  226. about using unregistered software, receive a distinctive
  227. "Blackbeard" collectable, a registration sticker, and a copy of
  228. the latest version of Blackbeard.  The file FORM.TXT can be used
  229. as an order form. California state residents please add 6% state
  230. tax (90 cents) for a total of $15.90.
  231.  
  232.  
  233.  
  234.          SEND A CHECK MADE OUT TO BLACKBEARD TO:
  235.  
  236.         Blackbeard
  237.         1198 E. Baseline St.  Suite 113
  238.         San Bernardino, California  92410
  239.  
  240.  
  241.          We thank you for your support.
  242.